Add UniHelp RB Code

If you are reading this, it is assumed that you have already created a Help Menu Item. In the Action Function of your help menu handler or help button, you will need to add the following code (this code has been revised version 1.0, so existing customers who upgrade to version 1.1 or higher will need to use the code below):

Function Action As Boolean

Dim qtcheck as QTEffect
Dim w,wnum as Integer
Dim helpexists as Boolean
Dim HelpWindow as UniHelp

helpexists = FALSE
For w = 0 to WindowCount-1
if Window(w) IsA UniHelp then
wnum = w
helpexists = TRUE
end if
next

If helpexists = FALSE then

HelpWindow = new UniHelp

//**************************************
// Edit the Variables Below to Customize UniHelp

HelpWindow.SerialNumber = "DEMO"
HelpWindow.Title = "UniHelp Developer Guide"
HelpWindow.IconCategory = bookgreen
HelpWindow.IconPage = docwhite
HelpWindow.FontName = "Arial"
HelpWindow.AltFont = "Helvetica"
HelpWindow.HelpFolder = "Help"
HelpWindow.StartPage = "001-Introduction.html"
HelpWindow.SearchTags = FALSE
HelpWindow.UILanguage = "ENGLISH"

// Edit the Variables Above to Customize UniHelp
//**************************************

qtcheck=GetQTCrossFadeEffect
if qtcheck = nil then
HelpWindow.QTStatus = FALSE
else
HelpWindow.QTStatus = TRUE
end if
HelpWindow.VertGrabber.backdrop = grabber
HelpWindow.BtnBack.backdrop = navback
HelpWindow.BtnNext.backdrop = navnext
HelpWindow.BtnHome.backdrop = navhome
HelpWindow.BtnCopy.backdrop = navcopy
HelpWindow.BtnPrint.backdrop = navprint
HelpWindow.CustomizeHelp
If HelpWindow.StartError = FALSE then
HelpWindow.show
End If

Else
Window(wnum).show
End If

You should edit the variables within the comments (above) to configure the look and feel of UniHelp. ALL of the variables are REQUIRED.

HelpWindow.SerialNumber = "DEMO"

After you've purchased a UniHelp Serial Number, you can convert the UniHelp Demo module into a Registered version by replacing "DEMO" in this variable with your actual Serial Number. With a valid Serial Number in place, the Unregistered Demo message that displays when either the "Contents" or "Search" buttons are clicked will be removed.

HelpWindow.Title = "UniHelp Developer Guide"

Change this variable to whatever name you want displayed in UniHelp's Window Title Bar, such as HelpWindow.Title = "My App's Help"

HelpWindow.IconCategory = bookgreen
HelpWindow.IconPage = docwhite

Customize the color of the icons that UniHelp displays in the table of contents listbox. The graphic file names are self-explanatory. "bookblue" is the blue book icon, "bookred" is the red book icon, "docgreen" is the green page icon, etc.

HelpWindow.FontName = "Arial"
HelpWindow.AltFont = "Helvetica"

This variable allows you to choose what display font is used in UniHelp's listbox and editfields. Always choose a common font that you know both Mac and Windows computers have. We recommend using Arial or Times as the main font choice. Just in case a user does not have the main FontName, the AltFont variable specifies an alternative font. So again, use a common font for the AltFont such as Helvetica, etc. If the user does not have either the main font or alternative font, then UniHelp use the system font instead.

HelpWindow.HelpFolder = "Help"
HelpWindow.StartPage = "001-Introduction.html"

The HelpFolder variable specifies the name of your central help folder (which should be located in the same directory as your compiled application in order for UniHelp to find it). The StartPage variable specifies the name of the help page that you wish to load first when UniHelp is launched -- typically this should be an introductory page of some sort.

HelpWindow.SearchTags = FALSE

This boolean variable specifies whether or not HTML tags are ignored when UniHelp's built-in search engine is performing a search. FALSE means HTML tags are ignored in searches and TRUE means HTML tags are included in searches.

HelpWindow.UILanguage = "ENGLISH"

The UILanguage variable specifies what language you want the UniHelp interface elements to use -- this includes all button labels, dialog boxes, etc. UniHelp will not translate your help pages. You can change this variable to one of six choices: ENGLISH, SPANISH, FRENCH, GERMAN, ITALIAN or PORTUGUESE. You must type them in capital letters. For example: HelpWindow.UILanguage = "FRENCH"

Copyright 2002 (c) Electric Butterfly, Inc. All Rights Reserved.